Api.ReadAxisTouchProbeStatus method

Reads the variable (#x60B9) of the touch probe state.

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsReturn<ushort> ReadAxisTouchProbeStatus(
       int Index
)

Public Function ReadAxisTouchProbeStatus(
       Index As Integer
) As KsReturn(Of UShort)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Returns a KsError code and an unsigned short integer value.

Remarks

To use this method, touch probe must be enabled using EnableTouchProbe.

Usable EtherCAT states

ecatOP

Examples

N/A